<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Data Source Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">DataSource Element</p>
<h1>Element Overview</h1>
<div class="section-text">
The data source element represents a connection to an 
external data system.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Data Source</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>None</code></td></tr>
<tr><td>Extends:</td>
<td><a href="ReportElement.html">ReportElement</a></td></tr>
<tr><td>Extendable:</td>
<td>No</td></tr>
<tr><td>Abstract:</td>
<td>Yes</td></tr>
<tr><td>Name Space:</td>
<td>Data Sources</td></tr>
<tr><td>Name Requirement:</td>
<td>Required</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Method Summary</h3>

<dl class="section-text">
<dt><a href="#Method-afterClose">afterClose</a></dt>
<dd>Called just after closing the data source connection.</dd>
<dt><a href="#Method-afterOpen">afterOpen</a></dt>
<dd>Perform initialization after opening the data source connection for data access.</dd>
<dt><a href="#Method-beforeClose">beforeClose</a></dt>
<dd>Called just before closing the data source connection.</dd>
<dt><a href="#Method-beforeOpen">beforeOpen</a></dt>
<dd>Perform initialization before opening the data source connection for data access.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>
</p>
<h3>Inherited Property Notes</h3>

<dl class="section-text">
<dt><a href="ReportElement.html#Property-name">name</a></dt>
<dd>The name is required for a data source. Data sets use 
this name to associate themselves with the data source.</dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>The Data Source script methods execute as methods of a 
JavaScript object that represents the data source. See the Data Scripting 
Objects section for a description of the
<code>DataSource</code> scripting 
object.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>DataSource</code> scripting object</p></div>
<h1>Method Detail</h1>

<h2><a name="Method-afterClose">afterClose Method</a></h2>

<p class="section-text">Called just after closing the data source connection.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.afterClose(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Called just after BIRT closes the data source. Allows the 
application to perform code-based cleanup.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>beforeClose</code> method</p></div>

<hr>
<h2><a name="Method-afterOpen">afterOpen Method</a></h2>

<p class="section-text">Perform initialization after opening the data source connection for data access.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.afterOpen(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Called just after BIRT opens the data source. Allows the 
application to perform any code-based initialization required for the data 
source.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>beforeOpen</code> method</p></div>

<hr>
<h2><a name="Method-beforeClose">beforeClose Method</a></h2>

<p class="section-text">Called just before closing the data source connection.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.beforeClose(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Called just before BIRT closes the data source. Allows 
the application to perform code-based cleanup.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>afterClose</code> method</p></div>

<hr>
<h2><a name="Method-beforeOpen">beforeOpen Method</a></h2>

<p class="section-text">Perform initialization before opening the data source connection for data access.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.beforeOpen(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Called just before BIRT opens the data source. Allows the 
application to customize the data source properties.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>afterOpen</code> method</p></div>
</body>
</html>
